added usage example to gdk_event_request_motions() docs.

Wed Jul  4 12:20:23 2007  Tim Janik  <timj@imendio.com>

        * gdk/gdkevents.c (gdk_event_request_motions): added usage example
        to gdk_event_request_motions() docs.

svn path=/trunk/; revision=18378

diff --git a/ChangeLog b/ChangeLog
index 02273abbbb08df379d3a6d99ea0a2140e1ff80bd..4eb7f5cf2357b384c9005d6f6c293e1bf7ec204c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Wed Jul  4 12:20:23 2007  Tim Janik  <timj@imendio.com>
+
+       * gdk/gdkevents.c (gdk_event_request_motions): added usage example
+       to gdk_event_request_motions() docs.
+
 2007-07-04  Tor Lillqvist  <tml@novell.com>
 
        * gtk/gtkstatusicon.c: On Win32 call

diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index 40998e79fdf012808469e891c503dce45f52f21f..1c58aadc8934e8a087f4b1e6cfa6c631d45b415a 100644 (file)
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -840,7 +840,17 @@ gdk_event_get_axis (GdkEvent   *event,
  * This function should be used instead of gdk_window_get_pointer() to
  * request further motion notifies, because it also works for extension
  * events where motion notifies are provided for devices other than the
- * core pointer.
+ * core pointer. Coordinate extraction, processing and requesting more
+ * motion events from a %GDK_MOTION_NOTIFY event usually works like this:
+ *
+ * <informalexample><programlisting>
+ * {  // motion_event handler
+ *   x = motion_event->x;
+ *   y = motion_event->y;
+ *   ; // handle (x,y) motion
+ *   gdk_event_request_motions (motion_event); // handles is_hint events
+ * }
+ * </programlisting></informalexample>
  *
  * Since: 2.12
  **/